.. _CScreenChapter Class: ========================== CScreenChapter Class ========================== .. toctree:: :maxdepth: 1 * :ref:`Overview` * :ref:`Quick Reference` * :ref:`Constructors` * :ref:`Methods` ---- .. _CScreenChapter_Overview: Overview --------------- .. note:: The **CScreenChapter** class handles chapter screens and dream transitions The structure used for this class is :ref:`CScreenChapter` ---- .. _CScreenChapter_QuickRef: Quick Reference --------------- +-------------------------------------------------------------------------------------------------------------------------------------+ | **Quick Ref** | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:CScreenChapter**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:~CScreenChapter**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:CheckMouseLButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:CheckMouseMove**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:CheckMouseRButton**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:CheckSystemKeyCtrl**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:CancelEngine**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineActivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineDeactivated**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineDestroyed**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineGameInit**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineInitialized**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:EngineGameUninit**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:GetEngineState**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:GetNextDreamIndex**\(long\& nDream) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual short **CScreenChapter\:\:GetNumVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int\* **CScreenChapter\:\:GetVirtualKeysFlags**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual :ref:`CKeyInfo`\* **CScreenChapter\:\:GetVirtualKeys**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenChapter\:\:IsDoneButtonClickable**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenChapter\:\:IsReplayButtonClickable**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:OnDoneButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnKeyDown**\(int nKeysFlags) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnLButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnLButtonDblClk**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnLButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnRButtonDown**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnRButtonUp**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:OnMixerInitialize**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnMouseMove**\(:ref:`CPoint` cPoint) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:OnPortraitLClick**\(unsigned long id) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:OnReplayButtonClick**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:ResetMainPanel**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:SetSystemKeyCtrl**\(unsigned char bValue) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StartChapter**\(:ref:`CResRef`\& cResText) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StartChapterMultiplayerHost**\(unsigned char nChapter, unsigned char\* chapterResRef) | +-------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenChapter\:\:StartDream**\(unsigned char bRenting, :ref:`CString`\& dreamOverride) | +-------------------------------------------------------------------------------------------------------------------------------------+ | int **CScreenChapter\:\:StartText**\(:ref:`CResRef`\& cResText) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StartTextScreen**\(:ref:`CString`\& textscreenOverride) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StartTextScreenMultiplayerHost**\(unsigned char\* textscreenResRef) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StopDream**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual int **CScreenChapter\:\:StopMusic**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StopText**\(int bNotifyServer) | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:StopTextScreen**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | void **CScreenChapter\:\:SwitchMainPanel**\(unsigned long dwMainPanelId) | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:TimerAsynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ | virtual void **CScreenChapter\:\:TimerSynchronousUpdate**\() | +-------------------------------------------------------------------------------------------------------------------------------------+ ---- .. _CScreenChapter_Constructors: Constructors --------------- +-------------------------------------------------------------------------+------------------------------------------------------+ | **Name** | **Description** | +-------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenChapter\:\:CScreenChapter` | Constructs a ``CScreenChapter`` object | +-------------------------------------------------------------------------+------------------------------------------------------+ | :ref:`CScreenChapter\:\:~CScreenChapter` | Destroys a ``CScreenChapter`` object | +-------------------------------------------------------------------------+------------------------------------------------------+ .. _CScreenChapterCScreenChapter: CScreenChapter\:\:CScreenChapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Constructs a ``CScreenChapter`` object :: void CScreenChapter::CScreenChapter(); **Remarks** Constructs a ``CScreenChapter`` object ---- .. _CScreenChapter~CScreenChapter: CScreenChapter\:\:~CScreenChapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Destroys the ``CScreenChapter`` object :: virtual void CScreenChapter::~CScreenChapter(); **Remarks** Destroys the ``CScreenChapter`` object ---- .. _CScreenChapter_Methods: Methods --------------- +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | **Name** | **Description** | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:CheckMouseLButton` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:CheckMouseMove` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:CheckMouseRButton` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:CheckSystemKeyCtrl` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:CancelEngine` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineActivated` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineDeactivated` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineDestroyed` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineGameInit` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineInitialized` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:EngineGameUninit` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:GetEngineState` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:GetNextDreamIndex` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:GetNumVirtualKeys` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:GetVirtualKeysFlags` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:GetVirtualKeys` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:IsDoneButtonClickable` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:IsReplayButtonClickable` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnDoneButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnKeyDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnLButtonDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnLButtonDblClk` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnLButtonUp` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnRButtonDown` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnRButtonUp` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnMixerInitialize` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnMouseMove` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnPortraitLClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:OnReplayButtonClick` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:ResetMainPanel` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:SetSystemKeyCtrl` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartChapter` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartChapterMultiplayerHost` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartDream` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartText` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartTextScreen` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StartTextScreenMultiplayerHost` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StopDream` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StopMusic` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StopText` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:StopTextScreen` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:SwitchMainPanel` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:TimerAsynchronousUpdate` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ | :ref:`CScreenChapter\:\:TimerSynchronousUpdate` | | +-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+ ---- .. _CScreenChapterCheckMouseLButton: CScreenChapter\:\:CheckMouseLButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::CheckMouseLButton(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterCheckMouseMove: CScreenChapter\:\:CheckMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::CheckMouseMove(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterCheckMouseRButton: CScreenChapter\:\:CheckMouseRButton ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::CheckMouseRButton(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterCheckSystemKeyCtrl: CScreenChapter\:\:CheckSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::CheckSystemKeyCtrl(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterCancelEngine: CScreenChapter\:\:CancelEngine ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::CancelEngine(); **Remarks** ---- .. _CScreenChapterEngineActivated: CScreenChapter\:\:EngineActivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineActivated(); **Remarks** ---- .. _CScreenChapterEngineDeactivated: CScreenChapter\:\:EngineDeactivated ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineDeactivated(); **Remarks** ---- .. _CScreenChapterEngineDestroyed: CScreenChapter\:\:EngineDestroyed ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineDestroyed(); **Remarks** ---- .. _CScreenChapterEngineGameInit: CScreenChapter\:\:EngineGameInit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineGameInit(); **Remarks** ---- .. _CScreenChapterEngineInitialized: CScreenChapter\:\:EngineInitialized ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineInitialized(); **Remarks** ---- .. _CScreenChapterEngineGameUninit: CScreenChapter\:\:EngineGameUninit ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::EngineGameUninit(); **Remarks** ---- .. _CScreenChapterGetEngineState: CScreenChapter\:\:GetEngineState ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::GetEngineState(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterGetNextDreamIndex: CScreenChapter\:\:GetNextDreamIndex ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::GetNextDreamIndex(long& nDream); **Parameters** * ``long``\& *nDream* - **Remarks** ---- .. _CScreenChapterGetNumVirtualKeys: CScreenChapter\:\:GetNumVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual short CScreenChapter::GetNumVirtualKeys(); **Return Value** ``short`` **Remarks** ---- .. _CScreenChapterGetVirtualKeysFlags: CScreenChapter\:\:GetVirtualKeysFlags ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int\* CScreenChapter::GetVirtualKeysFlags(); **Return Value** ``int``\* **Remarks** ---- .. _CScreenChapterGetVirtualKeys: CScreenChapter\:\:GetVirtualKeys ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual :ref:`CKeyInfo`\* CScreenChapter::GetVirtualKeys(); **Return Value** Returns :ref:`CKeyInfo`\* **Remarks** ---- .. _CScreenChapterIsDoneButtonClickable: CScreenChapter\:\:IsDoneButtonClickable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: int CScreenChapter::IsDoneButtonClickable(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterIsReplayButtonClickable: CScreenChapter\:\:IsReplayButtonClickable ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: int CScreenChapter::IsReplayButtonClickable(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterOnDoneButtonClick: CScreenChapter\:\:OnDoneButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::OnDoneButtonClick(); **Remarks** ---- .. _CScreenChapterOnKeyDown: CScreenChapter\:\:OnKeyDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnKeyDown(int nKeysFlags); **Parameters** * ``int`` *nKeysFlags* - **Remarks** ---- .. _CScreenChapterOnLButtonDown: CScreenChapter\:\:OnLButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnLButtonDown(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnLButtonDblClk: CScreenChapter\:\:OnLButtonDblClk ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnLButtonDblClk(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnLButtonUp: CScreenChapter\:\:OnLButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnLButtonUp(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnRButtonDown: CScreenChapter\:\:OnRButtonDown ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnRButtonDown(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnRButtonUp: CScreenChapter\:\:OnRButtonUp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnRButtonUp(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnMixerInitialize: CScreenChapter\:\:OnMixerInitialize ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::OnMixerInitialize(); **Remarks** ---- .. _CScreenChapterOnMouseMove: CScreenChapter\:\:OnMouseMove ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnMouseMove(:ref:`CPoint` cPoint); **Parameters** * :ref:`CPoint` *cPoint* - **Remarks** ---- .. _CScreenChapterOnPortraitLClick: CScreenChapter\:\:OnPortraitLClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::OnPortraitLClick(unsigned long id); **Parameters** * ``unsigned long`` *id* - **Remarks** ---- .. _CScreenChapterOnReplayButtonClick: CScreenChapter\:\:OnReplayButtonClick ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::OnReplayButtonClick(); **Remarks** ---- .. _CScreenChapterResetMainPanel: CScreenChapter\:\:ResetMainPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::ResetMainPanel(); **Remarks** ---- .. _CScreenChapterSetSystemKeyCtrl: CScreenChapter\:\:SetSystemKeyCtrl ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::SetSystemKeyCtrl(unsigned char bValue); **Parameters** * ``unsigned char`` *bValue* - **Remarks** ---- .. _CScreenChapterStartChapter: CScreenChapter\:\:StartChapter ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StartChapter(:ref:`CResRef`\& cResText); **Parameters** * :ref:`CResRef`\& *cResText* - **Remarks** ---- .. _CScreenChapterStartChapterMultiplayerHost: CScreenChapter\:\:StartChapterMultiplayerHost ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StartChapterMultiplayerHost( unsigned char nChapter, unsigned char* chapterResRef); **Parameters** * ``unsigned char`` *nChapter* - * ``unsigned char``\* *chapterResRef* - **Remarks** ---- .. _CScreenChapterStartDream: CScreenChapter\:\:StartDream ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: int CScreenChapter::StartDream( unsigned char bRenting, CString& dreamOverride); **Parameters** * ``unsigned char`` *bRenting* - * :ref:`CString`\& *dreamOverride* - **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterStartText: CScreenChapter\:\:StartText ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: int CScreenChapter::StartText(:ref:`CResRef`\& cResText); **Parameters** * :ref:`CResRef`\& *cResText* - **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterStartTextScreen: CScreenChapter\:\:StartTextScreen ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StartTextScreen(:ref:`CString`\& textscreenOverride); **Parameters** * :ref:`CString`\& *textscreenOverride* - **Remarks** ---- .. _CScreenChapterStartTextScreenMultiplayerHost: CScreenChapter\:\:StartTextScreenMultiplayerHost ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StartTextScreenMultiplayerHost(unsigned char\* textscreenResRef); **Parameters** * unsigned char\* *textscreenResRef* - **Remarks** ---- .. _CScreenChapterStopDream: CScreenChapter\:\:StopDream ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StopDream(); **Remarks** ---- .. _CScreenChapterStopMusic: CScreenChapter\:\:StopMusic ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual int CScreenChapter::StopMusic(); **Return Value** ``int`` **Remarks** ---- .. _CScreenChapterStopText: CScreenChapter\:\:StopText ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StopText(int bNotifyServer); **Parameters** * ``int`` *bNotifyServer* - **Remarks** ---- .. _CScreenChapterStopTextScreen: CScreenChapter\:\:StopTextScreen ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::StopTextScreen(); **Remarks** ---- .. _CScreenChapterSwitchMainPanel: CScreenChapter\:\:SwitchMainPanel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: void CScreenChapter::SwitchMainPanel(unsigned long dwMainPanelId); **Parameters** * ``unsigned long`` *dwMainPanelId* - **Remarks** ---- .. _CScreenChapterTimerAsynchronousUpdate: CScreenChapter\:\:TimerAsynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::TimerAsynchronousUpdate(); **Remarks** ---- .. _CScreenChapterTimerSynchronousUpdate: CScreenChapter\:\:TimerSynchronousUpdate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ :: virtual void CScreenChapter::TimerSynchronousUpdate(); **Remarks**